OpenAI.HttpClient to Azure.HttpClient mapper for test instrumentation #47416

jpalvarezl · 2025-12-02T12:05:16Z

Created a translation layer to be able to use the test-proxy tool with non-Azure HttpClients
Translation layer implemented for Stainless OpenAI HttpClient
Verified with com.azure.ai.agents.ConversationsTests#basicCRUDOperations. The recordings were generated and sanitized correctly in the expected repository here

Copilot

Pull request overview

This PR introduces a translation layer to enable the use of the test-proxy tool with the Stainless-generated OpenAI HttpClient. The implementation bridges Azure's HTTP pipeline (including policies, diagnostics, and retry logic) with OpenAI SDK clients, allowing test recording and sanitization to work correctly.

Key changes:

Introduced HTTP client adapters to convert between OpenAI and Azure HTTP abstractions
Added policy decoration capability to inject Azure pipeline policies into OpenAI HTTP clients
Implemented URL building logic to construct Azure-compatible URLs from OpenAI request metadata

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
`PolicyDecoratingHttpClient.java`	Wraps HttpClient with Azure pipeline policies for test instrumentation
`HttpClientHelper.java`	Main translation layer mapping OpenAI HttpClient to Azure HttpClient
`OpenAiRequestUrlBuilder.java`	Utility to construct absolute URLs from OpenAI request components
`AzureHttpResponseAdapter.java`	Adapts Azure HttpResponse to OpenAI HttpResponse interface
`AgentsClientBuilder.java`	Integrates the HTTP client mapper into client build methods
`PolicyDecoratingHttpClientTests.java`	Unit tests for policy decoration functionality
`HttpClientHelperTests.java`	Unit tests for request/response translation

...e-ai-agents/src/test/java/com/azure/ai/agents/implementation/http/HttpClientHelperTests.java

...s/src/test/java/com/azure/ai/agents/implementation/http/PolicyDecoratingHttpClientTests.java

...agents/src/main/java/com/azure/ai/agents/implementation/http/PolicyDecoratingHttpClient.java

...i-agents/src/main/java/com/azure/ai/agents/implementation/http/AzureHttpResponseAdapter.java

...ai-agents/src/main/java/com/azure/ai/agents/implementation/http/OpenAiRequestUrlBuilder.java

sdk/ai/azure-ai-agents/src/main/java/com/azure/ai/agents/AgentsClientBuilder.java

...ai-agents/src/main/java/com/azure/ai/agents/implementation/http/OpenAiRequestUrlBuilder.java

.../azure-ai-agents/src/main/java/com/azure/ai/agents/implementation/http/HttpClientHelper.java

sdk/ai/azure-ai-agents/src/main/java/com/azure/ai/agents/AgentsClientBuilder.java

srnagar · 2025-12-02T19:17:04Z

...i-agents/src/main/java/com/azure/ai/agents/implementation/http/AzureHttpResponseAdapter.java

+     */
+    AzureHttpResponseAdapter(com.azure.core.http.HttpResponse azureResponse) {
+        this.azureResponse = azureResponse;
+        this.headers = toOpenAiHeaders(azureResponse.getHeaders());


Let's not eagerly do the mapping here. Response headers are not usually accessed. So, we can do this mapping lazily when headers method is called for the first time.

I did the same for body(). Because it returns an InputStream the responsibility to close the stream is pushed to the caller.

srnagar · 2025-12-02T19:22:10Z

sdk/ai/azure-ai-agents/src/main/java/com/azure/ai/agents/AgentsClientBuilder.java

+        if (this.httpClient == null) {
+            return null;
+        }
+        List<HttpPipelinePolicy> orderedPolicies = getOrderedCustomPolicies();


If the user only configures custom policies but not the HTTP client the policies are ignored and the default HTTP client will be used. We should use the provided pipeline policies in all cases.

srnagar · 2025-12-02T20:06:38Z

sdk/ai/azure-ai-agents/src/main/java/com/azure/ai/agents/AgentsClientBuilder.java

+        HttpClient decoratedHttpClient = getOpenAIHttpClient();
+        return new ConversationsClient(getOpenAIClientBuilder().build().withOptions(optionBuilder -> {
+            if (decoratedHttpClient != null) {
+                optionBuilder.httpClient(HttpClientHelper.httpClientMapper(decoratedHttpClient));


This will switch from OpenAI's HTTP client to Azure's HTTP client when there is a custom policy. Should we always use the Azure HTTP client to avoid different behaviors/HTTP clients? It would be good to have a consistent behavior regardless of how the client builder was configured. Or, we should clearly document that setting custom policy will result in a different HTTP client being used.

.../azure-ai-agents/src/main/java/com/azure/ai/agents/implementation/http/HttpClientHelper.java

srnagar · 2025-12-02T21:26:21Z

.../azure-ai-agents/src/main/java/com/azure/ai/agents/implementation/http/HttpClientHelper.java

+        private static HttpHeaders toAzureHeaders(Headers sourceHeaders) {
+            HttpHeaders target = new HttpHeaders();
+            sourceHeaders.names().forEach(name -> {
+                List<String> values = sourceHeaders.values(name);
+                HttpHeaderName headerName = HttpHeaderName.fromString(name);
+                if (values.isEmpty()) {
+                    target.set(headerName, "");
+                } else {
+                    target.set(headerName, values);
+                }
+            });
+            return target;
+        }


Same here - this results in looping through each header twice. Instead, updating the Headers class to return a Map<String, List<String>> can be useful.

srnagar · 2025-12-02T21:31:19Z

.../azure-ai-agents/src/main/java/com/azure/ai/agents/implementation/http/HttpClientHelper.java

+                try {
+                    bodyData = toBinaryData(requestBody);
+                } finally {
+                    closeQuietly(requestBody);


If the source request body didn't close cleanly, then we should bubble that exception up as that indicates some issue with the underlying data source.

srnagar · 2025-12-02T22:13:33Z

.../azure-ai-agents/src/main/java/com/azure/ai/agents/implementation/http/HttpClientHelper.java

+                return failedFuture(runtimeException);
+            }
+
+            return this.azureHttpClient.send(azureRequest)


When an exception is thrown, we should map that as well to OpenAI exception types.

srnagar · 2025-12-02T22:27:46Z

...ai-agents/src/main/java/com/azure/ai/agents/implementation/http/OpenAiRequestUrlBuilder.java

+    static URL buildUrl(HttpRequest request) {
+        try {
+            URI baseUri = URI.create(request.baseUrl());
+            URL baseUrl = baseUri.toURL();
+            String path = buildPath(baseUrl.getPath(), request.pathSegments());
+            String query = buildQueryString(request.queryParams());
+            URI resolved = new URI(baseUrl.getProtocol(), baseUrl.getUserInfo(), baseUrl.getHost(), baseUrl.getPort(),
+                path, query, null);
+            return resolved.toURL();


This should be internal to the HttpRequest type and we should avoid stitching these pieces together as this could break if something changes in OpenAI library. Instead, can we move this logic to HttpRequest type where it can return a full URL? There should already be a place where this is done in the OpenAI library, we just have to offer that as a public API.

srnagar · 2025-12-02T22:34:19Z

sdk/ai/azure-ai-agents/src/main/java/com/azure/ai/agents/AgentsClientBuilder.java

+            return null;
+        }
+        List<HttpPipelinePolicy> orderedPolicies = getOrderedCustomPolicies();
+        if (orderedPolicies.isEmpty()) {


This builder also supports setting retryPolicy or retryOptions directly (not through addPolicy() method). It looks like that will have no effect on OpenAI HTTP client. Should we consider that to be a custom policy?

Copilot · 2025-12-03T10:03:40Z

@jpalvarezl I've opened a new pull request, #47428, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-12-03T10:03:46Z

@jpalvarezl I've opened a new pull request, #47429, to work on those changes. Once the pull request is ready, I'll request review from you.

…mentation/http/OpenAiRequestUrlBuilder.java Co-authored-by: Copilot <[email protected]>

…mentation/http/PolicyDecoratingHttpClient.java Co-authored-by: Copilot <[email protected]>

…pClient (#47429) * Initial plan * Add async and error propagation test coverage for PolicyDecoratingHttpClient Co-authored-by: jpalvarezl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: jpalvarezl <[email protected]> Co-authored-by: Jose Alvarez <[email protected]>

* Initial plan * Add error handling tests for HttpClientHelper Added comprehensive error handling test cases including: - Null request body handling - IOException during body buffering - Malformed URLs - Async execution failures Co-authored-by: jpalvarezl <[email protected]> * Address code review feedback on error handling tests - Simplify FailingHttpRequestBody to directly throw UncheckedIOException - Improve assertion clarity in body buffering test - Remove fragile message checking in malformed URL test Co-authored-by: jpalvarezl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: jpalvarezl <[email protected]> Co-authored-by: Jose Alvarez <[email protected]>

Porting over changes from private repo

89496d3

Copilot AI review requested due to automatic review settings December 2, 2025 12:05

jpalvarezl requested review from a team, dargilco and trrwilson as code owners December 2, 2025 12:05

github-actions bot added the AI label Dec 2, 2025

Copilot started reviewing on behalf of jpalvarezl December 2, 2025 12:06 View session

Copilot finished reviewing on behalf of jpalvarezl December 2, 2025 12:10

Copilot AI reviewed Dec 2, 2025

View reviewed changes

dargilco approved these changes Dec 2, 2025

View reviewed changes

formatting

eca457f

srnagar reviewed Dec 2, 2025

View reviewed changes

Copilot AI mentioned this pull request Dec 3, 2025

Add error handling tests for HttpClientHelper #47428

Merged

6 tasks

Copilot AI mentioned this pull request Dec 3, 2025

Add async and error propagation test coverage for PolicyDecoratingHttpClient #47429

Merged

6 tasks

jpalvarezl and others added 14 commits December 3, 2025 11:06

Update sdk/ai/azure-ai-agents/src/main/java/com/azure/ai/agents/imple…

954ba7d

…mentation/http/OpenAiRequestUrlBuilder.java Co-authored-by: Copilot <[email protected]>

Update sdk/ai/azure-ai-agents/src/main/java/com/azure/ai/agents/imple…

4df3dba

…mentation/http/PolicyDecoratingHttpClient.java Co-authored-by: Copilot <[email protected]>

Formatting mismatch

385e9b5

Merged and improved assertions

224e3fb

More PR feedback

672a6df

More PR feedback

d4505e6

More PR feedback

bf085da

lazy mapping of types for the AzureHttpResponseAdapter

226c2c0

Simplified mapping

7c95643

Always using default httpPipeline

867d0d6

Using bare minimum code

6bf38b7

WIP: removing redundant code. Using default httpPipeline

7c1b414

OpenAI.HttpClient to Azure.HttpClient mapper for test instrumentation #47416

Are you sure you want to change the base?

OpenAI.HttpClient to Azure.HttpClient mapper for test instrumentation #47416

Uh oh!

Conversation

jpalvarezl commented Dec 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srnagar Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Dec 3, 2025

Uh oh!

Copilot AI commented Dec 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

srnagar Dec 2, 2025 •

edited

Loading